package top.lixunda.ecommerce.server.user.api.controller;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.*;
import top.lixunda.commerce.common.core.entity.MessageObject;
import top.lixunda.ecommerce.server.user.api.entity.dto.SystemMenuChangeDTO;
import top.lixunda.ecommerce.server.user.api.entity.dto.SystemMenuInsertDTO;
import top.lixunda.ecommerce.server.user.api.entity.vo.SystemMenuTreeVO;
import top.lixunda.ecommerce.server.user.api.entity.vo.SystemMenuVO;

import java.util.List;

/**
 * 系统菜单管理接口
 *
 * @author lixunda
 * @version time:2020/4/26 9:46
 */
@Api("系统菜单管理接口")
@RequestMapping("/system_menu")
public interface ISystemMenuController {

    /**
     * 添加多个菜单目录
     *
     * @param list 新添加的菜单目录数据列表
     * @return 是否添加成功
     */
    @ApiOperation("添加多个菜单目录")
    @PostMapping("insertMenu")
    MessageObject<Boolean> insertMenu(@RequestBody List<SystemMenuInsertDTO> list);

    /**
     * 更新多个菜单目录
     *
     * @param list 需要更新的菜单目录数据列表
     * @return 是否更新成功
     */
    @ApiOperation("更新多个菜单目录")
    @PostMapping("updateMenuById")
    MessageObject<Boolean> updateMenuById(@RequestBody List<SystemMenuChangeDTO> list);

    /**
     * 根据id删除菜单目录，删除包括子节点的所有节点
     *
     * @param id 菜单目录id
     * @return 是否删除成功
     */
    @ApiOperation("根据id删除菜单目录，删除包括子节点的所有节点")
    @GetMapping("removeMenuAllById")
    MessageObject<Boolean> removeMenuAllById(@RequestParam("id") Integer id);

    /**
     * 根据id删除菜单目录，删除包括子节点的所有节点
     *
     * @param ids 菜单目录id
     * @return 是否删除成功
     */
    @ApiOperation("根据id删除菜单目录，删除包括子节点的所有节点")
    @PostMapping("removeMenuAllByIds")
    MessageObject<Boolean> removeMenuAllByIds(@RequestBody List<Integer> ids);

    /**
     * 根据id获取菜单目录数据
     *
     * @param id 菜单目录id
     * @return 单条菜单目录数据
     */
    @ApiOperation("根据id获取菜单目录数据")
    @GetMapping("queryById")
    MessageObject<SystemMenuVO> queryById(@RequestParam("id") Integer id);

    /**
     * 查询所有菜单目录信息
     *
     * @return 所有菜单目录信息
     */
    @ApiOperation("查询所有菜单目录信息")
    @GetMapping("queryAll")
    MessageObject<List<SystemMenuVO>> queryAll();

    /**
     * 查询所有菜单目录信息树形结构
     *
     * @return 所有菜单目录信息树形结构
     */
    @ApiOperation("查询所有菜单目录信息树形结构")
    @GetMapping("queryAllTree")
    MessageObject<List<SystemMenuTreeVO>> queryAllTree();

    /**
     * 根据菜单编码查询某一个子系统的菜单目录
     *
     * @param menuCode 菜单编码，唯一索引
     * @return 该子系统的菜单目录信息
     */
    @ApiOperation("根据菜单编码查询某一个子系统的菜单目录")
    @GetMapping("queryOneRootAllByCode")
    MessageObject<List<SystemMenuVO>> queryOneRootAllByCode(@RequestParam("menuCode") String menuCode);

    /**
     * 根据菜单编码查询某一个子系统的菜单目录树形结构数据
     *
     * @param menuCode 菜单编码，唯一索引
     * @return 该子系统的菜单目录信息树形结构数据
     */
    @ApiOperation("根据菜单编码查询某一个子系统的菜单目录树形结构数据")
    @GetMapping("queryOneRootAllTreeByCode")
    MessageObject<SystemMenuTreeVO> queryOneRootAllTreeByCode(@RequestParam("menuCode") String menuCode);

    /**
     * 根据父节点id获取子类节点列表
     *
     * @param id 父节点id
     * @return 子节点列表
     */
    @ApiOperation("根据父节点id获取子类节点列表")
    @GetMapping("queryChildrenByParentId")
    MessageObject<List<SystemMenuVO>> queryChildrenByParentId(@RequestParam("id") Integer id);

    /**
     * 查询首层节点
     *
     * @return 首层节点
     */
    @ApiOperation("查询首层节点")
    @GetMapping("queryRoots")
    MessageObject<List<SystemMenuVO>> queryRoots();

}
